<!DOCTYPE html>
<html lang="en-us">
  <head>

    <meta http-equiv="content-type" content="text/html; charset=utf-8">
    
<meta charset="UTF-8">
<title>Execute watch API | Elasticsearch Guide [7.7] | Elastic</title>
<link rel="home" href="index.html" title="Elasticsearch Guide [7.7]">
<link rel="up" href="watcher-api.html" title="Watcher APIs">
<link rel="prev" href="watcher-api-delete-watch.html" title="Delete watch API">
<link rel="next" href="watcher-api-get-watch.html" title="Get watch API">
<meta name="DC.type" content="Learn/Docs/Elasticsearch/Reference/7.7">
<meta name="DC.subject" content="Elasticsearch">
<meta name="DC.identifier" content="7.7">
<meta name="robots" content="noindex,nofollow">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <script src="https://cdn.optimizely.com/js/18132920325.js"></script>
    <link rel="apple-touch-icon" sizes="57x57" href="/apple-icon-57x57.png">
    <link rel="apple-touch-icon" sizes="60x60" href="/apple-icon-60x60.png">
    <link rel="apple-touch-icon" sizes="72x72" href="/apple-icon-72x72.png">
    <link rel="apple-touch-icon" sizes="76x76" href="/apple-icon-76x76.png">
    <link rel="apple-touch-icon" sizes="114x114" href="/apple-icon-114x114.png">
    <link rel="apple-touch-icon" sizes="120x120" href="/apple-icon-120x120.png">
    <link rel="apple-touch-icon" sizes="144x144" href="/apple-icon-144x144.png">
    <link rel="apple-touch-icon" sizes="152x152" href="/apple-icon-152x152.png">
    <link rel="apple-touch-icon" sizes="180x180" href="/apple-icon-180x180.png">
    <link rel="icon" type="image/png" href="/favicon-32x32.png" sizes="32x32">
    <link rel="icon" type="image/png" href="/android-chrome-192x192.png" sizes="192x192">
    <link rel="icon" type="image/png" href="/favicon-96x96.png" sizes="96x96">
    <link rel="icon" type="image/png" href="/favicon-16x16.png" sizes="16x16">
    <link rel="manifest" href="/manifest.json">
    <meta name="apple-mobile-web-app-title" content="Elastic">
    <meta name="application-name" content="Elastic">
    <meta name="msapplication-TileColor" content="#ffffff">
    <meta name="msapplication-TileImage" content="/mstile-144x144.png">
    <meta name="theme-color" content="#ffffff">
    <meta name="naver-site-verification" content="936882c1853b701b3cef3721758d80535413dbfd">
    <meta name="yandex-verification" content="d8a47e95d0972434">
    <meta name="localized" content="true">
    <meta name="st:robots" content="follow,index">
    <meta property="og:image" content="https://www.elastic.co/static/images/elastic-logo-200.png">
    <link rel="shortcut icon" href="/favicon.ico" type="image/x-icon">
    <link rel="icon" href="/favicon.ico" type="image/x-icon">
    <link rel="apple-touch-icon-precomposed" sizes="64x64" href="/favicon_64x64_16bit.png">
    <link rel="apple-touch-icon-precomposed" sizes="32x32" href="/favicon_32x32.png">
    <link rel="apple-touch-icon-precomposed" sizes="16x16" href="/favicon_16x16.png">
    <!-- Give IE8 a fighting chance -->
    <!--[if lt IE 9]>
    <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
    <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
    <![endif]-->
    <link rel="stylesheet" type="text/css" href="/guide/static/styles.css">
  </head>

  <!--© 2015-2021 Elasticsearch B.V. Copying, publishing and/or distributing without written permission is strictly prohibited.-->

  <body>
    <!-- Google Tag Manager -->
    <script>dataLayer = [];</script><noscript><iframe src="//www.googletagmanager.com/ns.html?id=GTM-58RLH5" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
    <script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start': new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0], j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src= '//www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f); })(window,document,'script','dataLayer','GTM-58RLH5');</script>
    <!-- End Google Tag Manager -->

    <!-- Global site tag (gtag.js) - Google Analytics -->
    <script async src="https://www.googletagmanager.com/gtag/js?id=UA-12395217-16"></script>
    <script>
      window.dataLayer = window.dataLayer || [];
      function gtag(){dataLayer.push(arguments);}
      gtag('js', new Date());
      gtag('config', 'UA-12395217-16');
    </script>

    <!--BEGIN QUALTRICS WEBSITE FEEDBACK SNIPPET-->
    <script type="text/javascript">
      (function(){var g=function(e,h,f,g){
      this.get=function(a){for(var a=a+"=",c=document.cookie.split(";"),b=0,e=c.length;b<e;b++){for(var d=c[b];" "==d.charAt(0);)d=d.substring(1,d.length);if(0==d.indexOf(a))return d.substring(a.length,d.length)}return null};
      this.set=function(a,c){var b="",b=new Date;b.setTime(b.getTime()+6048E5);b="; expires="+b.toGMTString();document.cookie=a+"="+c+b+"; path=/; "};
      this.check=function(){var a=this.get(f);if(a)a=a.split(":");else if(100!=e)"v"==h&&(e=Math.random()>=e/100?0:100),a=[h,e,0],this.set(f,a.join(":"));else return!0;var c=a[1];if(100==c)return!0;switch(a[0]){case "v":return!1;case "r":return c=a[2]%Math.floor(100/c),a[2]++,this.set(f,a.join(":")),!c}return!0};
      this.go=function(){if(this.check()){var a=document.createElement("script");a.type="text/javascript";a.src=g;document.body&&document.body.appendChild(a)}};
      this.start=function(){var a=this;window.addEventListener?window.addEventListener("load",function(){a.go()},!1):window.attachEvent&&window.attachEvent("onload",function(){a.go()})}};
      try{(new g(100,"r","QSI_S_ZN_emkP0oSe9Qrn7kF","https://znemkp0ose9qrn7kf-elastic.siteintercept.qualtrics.com/WRSiteInterceptEngine/?Q_ZID=ZN_emkP0oSe9Qrn7kF")).start()}catch(i){}})();
    </script><div id="ZN_emkP0oSe9Qrn7kF"><!--DO NOT REMOVE-CONTENTS PLACED HERE--></div>
    <!--END WEBSITE FEEDBACK SNIPPET-->

    <div id="elastic-nav" style="display:none;"></div>
    <script src="https://www.elastic.co/elastic-nav.js"></script>

    <!-- Subnav -->
    <div>
      <div>
        <div class="tertiary-nav d-none d-md-block">
          <div class="container">
            <div class="p-t-b-15 d-flex justify-content-between nav-container">
              <div class="breadcrum-wrapper"><span><a href="/guide/" style="font-size: 14px; font-weight: 600; color: #000;">Docs</a></span></div>
            </div>
          </div>
        </div>
      </div>
    </div>

    <div class="main-container">
      <section id="content">
        <div class="content-wrapper">

          <section id="guide" lang="en">
            <div class="container">
              <div class="row">
                <div class="col-xs-12 col-sm-8 col-md-8 guide-section">
                  <!-- start body -->
                  <div class="page_header">
<strong>IMPORTANT</strong>: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
<a href="../current/index.html">current release documentation</a>.
</div>
<div id="content">
<div class="breadcrumbs">
<span class="breadcrumb-link"><a href="index.html">Elasticsearch Guide [7.7]</a></span>
»
<span class="breadcrumb-link"><a href="rest-apis.html">REST APIs</a></span>
»
<span class="breadcrumb-link"><a href="watcher-api.html">Watcher APIs</a></span>
»
<span class="breadcrumb-node">Execute watch API</span>
</div>
<div class="navheader">
<span class="prev">
<a href="watcher-api-delete-watch.html">« Delete watch API</a>
</span>
<span class="next">
<a href="watcher-api-get-watch.html">Get watch API »</a>
</span>
</div>
<div class="section xpack">
<div class="titlepage"><div><div>
<h2 class="title">
<a id="watcher-api-execute-watch"></a>Execute watch API<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/x-pack/docs/en/rest-api/watcher/execute-watch.asciidoc">edit</a><a class="xpack_tag" href="/subscriptions"></a>
</h2>
</div></div></div>

<p>Forces the execution of a stored watch.</p>
<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="watcher-api-execute-watch-request"></a>Request<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/x-pack/docs/en/rest-api/watcher/execute-watch.asciidoc">edit</a>
</h3>
</div></div></div>
<p><code class="literal">POST _watcher/watch/&lt;watch_id&gt;/_execute</code><br></p>
<p><code class="literal">POST _watcher/watch/_execute</code></p>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="watcher-api-execute-watch-prereqs"></a>Prerequisites<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/x-pack/docs/en/rest-api/watcher/execute-watch.asciidoc">edit</a>
</h3>
</div></div></div>
<div class="ulist itemizedlist">
<ul class="itemizedlist">
<li class="listitem">
You must have <code class="literal">manage_watcher</code> cluster privileges to use this API. For more
information, see <a class="xref" href="security-privileges.html" title="Security privileges">Security privileges</a>.
</li>
</ul>
</div>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="watcher-api-execute-watch-desc"></a>Description<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/x-pack/docs/en/rest-api/watcher/execute-watch.asciidoc">edit</a>
</h3>
</div></div></div>
<p>This API can be used to force execution of the watch outside of its triggering
logic or to simulate the watch execution for debugging purposes.</p>
<p>For testing and debugging purposes, you also have fine-grained control on how
the watch runs. You can execute the watch without executing all of its actions
or alternatively by simulating them. You can also force execution by ignoring
the watch condition and control whether a watch record would be written to the
watch history after execution.</p>
<div class="section">
<div class="titlepage"><div><div>
<h4 class="title">
<a id="watcher-api-execute-inline-watch"></a>Inline watch execution<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/x-pack/docs/en/rest-api/watcher/execute-watch.asciidoc">edit</a>
</h4>
</div></div></div>
<p>You can use the Execute API to execute watches that are not yet registered by
specifying the watch definition inline. This serves as great tool for testing
and debugging your watches prior to adding them to Watcher.</p>
</div>

</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="watcher-api-execute-watch-path-params"></a>Path parameters<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/x-pack/docs/en/rest-api/watcher/execute-watch.asciidoc">edit</a>
</h3>
</div></div></div>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">&lt;watch_id&gt;</code>
</span>
</dt>
<dd>
(Optional, string) Identifier for the watch.
</dd>
</dl>
</div>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="watcher-api-execute-watch-query-params"></a>Query parameters<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/x-pack/docs/en/rest-api/watcher/execute-watch.asciidoc">edit</a>
</h3>
</div></div></div>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">debug</code>
</span>
</dt>
<dd>
(Optional, boolean) Defines whether the watch runs in debug mode. The default
value is <code class="literal">false</code>.
</dd>
</dl>
</div>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="watcher-api-execute-watch-request-body"></a>Request body<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/x-pack/docs/en/rest-api/watcher/execute-watch.asciidoc">edit</a>
</h3>
</div></div></div>
<p>This API supports the following fields:</p>
<div class="informaltable">
<table border="1" cellpadding="4px">
<colgroup>
<col class="col_1">
<col class="col_2">
<col class="col_3">
<col class="col_4">
</colgroup>
<thead>
<tr>
<th align="left" valign="top">Name</th>
<th align="center" valign="top">Required</th>
<th align="center" valign="top">Default</th>
<th align="left" valign="top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left" valign="top"><p><code class="literal">trigger_data</code></p></td>
<td align="center" valign="top"><p>no</p></td>
<td align="center" valign="top"><p></p></td>
<td align="left" valign="top"><p>This structure is parsed as the data of the trigger event
                                              that will be used during the watch execution</p></td>
</tr>
<tr>
<td align="left" valign="top"><p><code class="literal">ignore_condition</code></p></td>
<td align="center" valign="top"><p>no</p></td>
<td align="center" valign="top"><p>false</p></td>
<td align="left" valign="top"><p>When set to <code class="literal">true</code>, the watch execution uses the
                                              <a class="xref" href="condition-always.html" title="Always condition">always condition</a>.
                                              This can also be specified as an HTTP parameter.</p></td>
</tr>
<tr>
<td align="left" valign="top"><p><code class="literal">alternative_input</code></p></td>
<td align="center" valign="top"><p>no</p></td>
<td align="center" valign="top"><p>null</p></td>
<td align="left" valign="top"><p>When present, the watch uses this object as a payload
                                              instead of executing its own input.</p></td>
</tr>
<tr>
<td align="left" valign="top"><p><code class="literal">action_modes</code></p></td>
<td align="center" valign="top"><p>no</p></td>
<td align="center" valign="top"><p>null</p></td>
<td align="left" valign="top"><p>Determines how to handle the watch actions as part of the
                                              watch execution. See <a class="xref" href="watcher-api-execute-watch.html#watcher-api-execute-watch-action-mode" title="Action execution modes">Action execution modes</a>
                                              for more information.</p></td>
</tr>
<tr>
<td align="left" valign="top"><p><code class="literal">record_execution</code></p></td>
<td align="center" valign="top"><p>no</p></td>
<td align="center" valign="top"><p>false</p></td>
<td align="left" valign="top"><p>When set to <code class="literal">true</code>, the watch record representing the watch
                                              execution result is persisted to the <code class="literal">.watcher-history</code>
                                              index for the current time. In addition, the status of the
                                              watch is updated, possibly throttling subsequent executions.
                                              This can also be specified as an HTTP parameter.</p></td>
</tr>
<tr>
<td align="left" valign="top"><p><code class="literal">watch</code></p></td>
<td align="center" valign="top"><p>no</p></td>
<td align="center" valign="top"><p>null</p></td>
<td align="left" valign="top"><p>When present, this <a class="xref" href="how-watcher-works.html#watch-definition" title="Watch definition">watch</a> is used
                                              instead of the one specified in the request. This watch is
                                              not persisted to the index and record_execution cannot be set.</p></td>
</tr>
</tbody>
</table>
</div>
<div class="section">
<div class="titlepage"><div><div>
<h4 class="title">
<a id="watcher-api-execute-watch-action-mode"></a>Action execution modes<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/x-pack/docs/en/rest-api/watcher/execute-watch.asciidoc">edit</a>
</h4>
</div></div></div>
<p>Action modes define how actions are handled during the watch execution. There
are five possible modes an action can be associated with:</p>
<div class="informaltable">
<table border="1" cellpadding="4px">
<colgroup>
<col class="col_1">
<col class="col_2">
</colgroup>
<thead>
<tr>
<th align="left" valign="top">Name</th>
<th align="left" valign="top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left" valign="top"><p><code class="literal">simulate</code></p></td>
<td align="left" valign="top"><p>The action execution is simulated. Each action type
                      define its own simulation operation mode. For example, the
                      <a class="xref" href="actions-email.html" title="Email action"><code class="literal">email</code> action</a> creates
                      the email that would have been sent but does not actually
                      send it. In this mode, the action might be throttled if the
                      current state of the watch indicates it should be.</p></td>
</tr>
<tr>
<td align="left" valign="top"><p><code class="literal">force_simulate</code></p></td>
<td align="left" valign="top"><p>Similar to the <code class="literal">simulate</code> mode, except the action is
                      not be throttled even if the current state of the watch
                      indicates it should be.</p></td>
</tr>
<tr>
<td align="left" valign="top"><p><code class="literal">execute</code></p></td>
<td align="left" valign="top"><p>Executes the action as it would have been executed if the
                      watch would have been triggered by its own trigger. The
                      execution might be throttled if the current state of the
                      watch indicates it should be.</p></td>
</tr>
<tr>
<td align="left" valign="top"><p><code class="literal">force_execute</code></p></td>
<td align="left" valign="top"><p>Similar to the <code class="literal">execute</code> mode, except the action is not
                      throttled even if the current state of the watch indicates
                      it should be.</p></td>
</tr>
<tr>
<td align="left" valign="top"><p><code class="literal">skip</code></p></td>
<td align="left" valign="top"><p>The action is skipped and is not executed or simulated.
                      Effectively forces the action to be throttled.</p></td>
</tr>
</tbody>
</table>
</div>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h4 class="title">
<a id="watcher-api-execute-watch-security"></a>Security integration<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/x-pack/docs/en/rest-api/watcher/execute-watch.asciidoc">edit</a>
</h4>
</div></div></div>
<p>When Elasticsearch security features are enabled on your cluster, watches
are executed with the privileges of the user that stored the watches. If your
user is allowed to read index <code class="literal">a</code>, but not index <code class="literal">b</code>, then the exact same set of
rules will apply during execution of a watch.</p>
<p>When using the execute watch API, the authorization data of the user that
called the API will be used as a base, instead of of the information who stored
the watch.</p>
</div>

</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="watcher-api-execute-watch-example"></a>Examples<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/x-pack/docs/en/rest-api/watcher/execute-watch.asciidoc">edit</a>
</h3>
</div></div></div>
<p>The following example executes the <code class="literal">my_watch</code> watch:</p>
<div class="pre_wrapper lang-console">
<pre class="programlisting prettyprint lang-console">POST _watcher/watch/my_watch/_execute</pre>
</div>
<div class="console_widget" data-snippet="snippets/2174.console"></div>
<p>The following example shows a comprehensive example of executing the <code class="literal">my-watch</code> watch:</p>
<div class="pre_wrapper lang-console">
<pre class="programlisting prettyprint lang-console">POST _watcher/watch/my_watch/_execute
{
  "trigger_data" : { <a id="CO664-1"></a><i class="conum" data-value="1"></i>
     "triggered_time" : "now",
     "scheduled_time" : "now"
  },
  "alternative_input" : { <a id="CO664-2"></a><i class="conum" data-value="2"></i>
    "foo" : "bar"
  },
  "ignore_condition" : true, <a id="CO664-3"></a><i class="conum" data-value="3"></i>
  "action_modes" : {
    "my-action" : "force_simulate" <a id="CO664-4"></a><i class="conum" data-value="4"></i>
  },
  "record_execution" : true <a id="CO664-5"></a><i class="conum" data-value="5"></i>
}</pre>
</div>
<div class="console_widget" data-snippet="snippets/2175.console"></div>
<div class="calloutlist">
<table border="0" summary="Callout list">
<tr>
<td align="left" valign="top" width="5%">
<p><a href="#CO664-1"><i class="conum" data-value="1"></i></a></p>
</td>
<td align="left" valign="top">
<p>The triggered and schedule times are provided.</p>
</td>
</tr>
<tr>
<td align="left" valign="top" width="5%">
<p><a href="#CO664-2"><i class="conum" data-value="2"></i></a></p>
</td>
<td align="left" valign="top">
<p>The input as defined by the watch is ignored and instead the provided input
is used as the execution payload.</p>
</td>
</tr>
<tr>
<td align="left" valign="top" width="5%">
<p><a href="#CO664-3"><i class="conum" data-value="3"></i></a></p>
</td>
<td align="left" valign="top">
<p>The condition as defined by the watch is ignored and is assumed to
evaluate to <code class="literal">true</code>.</p>
</td>
</tr>
<tr>
<td align="left" valign="top" width="5%">
<p><a href="#CO664-4"><i class="conum" data-value="4"></i></a></p>
</td>
<td align="left" valign="top">
<p>Forces the simulation of <code class="literal">my-action</code>. Forcing the simulation means that
throttling is ignored and the watch is simulated by Watcher instead of
being executed normally.</p>
</td>
</tr>
<tr>
<td align="left" valign="top" width="5%">
<p><a href="#CO664-5"><i class="conum" data-value="5"></i></a></p>
</td>
<td align="left" valign="top">
<p>The execution of the watch creates a watch record in the watch history,
and the throttling state of the watch is potentially updated accordingly.</p>
</td>
</tr>
</table>
</div>
<p>This is an example of the output:</p>
<div class="pre_wrapper lang-console-result">
<pre class="programlisting prettyprint lang-console-result">{
  "_id": "my_watch_0-2015-06-02T23:17:55.124Z", <a id="CO665-1"></a><i class="conum" data-value="1"></i>
  "watch_record": { <a id="CO665-2"></a><i class="conum" data-value="2"></i>
    "watch_id": "my_watch",
    "node": "my_node",
    "messages": [],
    "trigger_event": {
      "type": "manual",
      "triggered_time": "2015-06-02T23:17:55.124Z",
      "manual": {
        "schedule": {
          "scheduled_time": "2015-06-02T23:17:55.124Z"
        }
      }
    },
    "state": "executed",
    "status": {
      "version": 1,
      "execution_state": "executed",
      "state": {
        "active": true,
        "timestamp": "2015-06-02T23:17:55.111Z"
      },
      "last_checked": "2015-06-02T23:17:55.124Z",
      "last_met_condition": "2015-06-02T23:17:55.124Z",
      "actions": {
        "test_index": {
          "ack": {
            "timestamp": "2015-06-02T23:17:55.124Z",
            "state": "ackable"
          },
          "last_execution": {
            "timestamp": "2015-06-02T23:17:55.124Z",
            "successful": true
          },
          "last_successful_execution": {
            "timestamp": "2015-06-02T23:17:55.124Z",
            "successful": true
          }
        }
      }
    },
    "input": {
      "simple": {
        "payload": {
          "send": "yes"
        }
      }
    },
    "condition": {
      "always": {}
    },
    "result": { <a id="CO665-3"></a><i class="conum" data-value="3"></i>
      "execution_time": "2015-06-02T23:17:55.124Z",
      "execution_duration": 12608,
      "input": {
        "type": "simple",
        "payload": {
          "foo": "bar"
        },
        "status": "success"
      },
      "condition": {
        "type": "always",
        "met": true,
        "status": "success"
      },
      "actions": [
        {
          "id": "test_index",
          "index": {
            "response": {
              "index": "test",
              "type": "_doc",
              "version": 1,
              "created": true,
              "result": "created",
              "id": "AVSHKzPa9zx62AzUzFXY"
            }
          },
          "status": "success",
          "type": "index"
        }
      ]
    },
    "user": "test_admin" <a id="CO665-4"></a><i class="conum" data-value="4"></i>
  }
}</pre>
</div>
<div class="calloutlist">
<table border="0" summary="Callout list">
<tr>
<td align="left" valign="top" width="5%">
<p><a href="#CO665-1"><i class="conum" data-value="1"></i></a></p>
</td>
<td align="left" valign="top">
<p>The id of the watch record as it would be stored in the <code class="literal">.watcher-history</code> index.</p>
</td>
</tr>
<tr>
<td align="left" valign="top" width="5%">
<p><a href="#CO665-2"><i class="conum" data-value="2"></i></a></p>
</td>
<td align="left" valign="top">
<p>The watch record document as it would be stored in the <code class="literal">.watcher-history</code> index.</p>
</td>
</tr>
<tr>
<td align="left" valign="top" width="5%">
<p><a href="#CO665-3"><i class="conum" data-value="3"></i></a></p>
</td>
<td align="left" valign="top">
<p>The watch execution results.</p>
</td>
</tr>
<tr>
<td align="left" valign="top" width="5%">
<p><a href="#CO665-4"><i class="conum" data-value="4"></i></a></p>
</td>
<td align="left" valign="top">
<p>The user used to execute the watch.</p>
</td>
</tr>
</table>
</div>
<p>You can set a different execution mode for every action by associating the mode
name with the action id:</p>
<div class="pre_wrapper lang-console">
<pre class="programlisting prettyprint lang-console">POST _watcher/watch/my_watch/_execute
{
  "action_modes" : {
    "action1" : "force_simulate",
    "action2" : "skip"
  }
}</pre>
</div>
<div class="console_widget" data-snippet="snippets/2176.console"></div>
<p>You can also associate a single execution mode with all the actions in the watch
using <code class="literal">_all</code> as the action id:</p>
<div class="pre_wrapper lang-console">
<pre class="programlisting prettyprint lang-console">POST _watcher/watch/my_watch/_execute
{
  "action_modes" : {
    "_all" : "force_execute"
  }
}</pre>
</div>
<div class="console_widget" data-snippet="snippets/2177.console"></div>
<p>The following example shows how to execute a watch inline:</p>
<div class="pre_wrapper lang-console">
<pre class="programlisting prettyprint lang-console">POST _watcher/watch/_execute
{
  "watch" : {
    "trigger" : { "schedule" : { "interval" : "10s" } },
    "input" : {
      "search" : {
        "request" : {
          "indices" : [ "logs" ],
          "body" : {
            "query" : {
              "match" : { "message": "error" }
            }
          }
        }
      }
    },
    "condition" : {
      "compare" : { "ctx.payload.hits.total" : { "gt" : 0 }}
    },
    "actions" : {
      "log_error" : {
        "logging" : {
          "text" : "Found {{ctx.payload.hits.total}} errors in the logs"
        }
      }
    }
  }
}</pre>
</div>
<div class="console_widget" data-snippet="snippets/2178.console"></div>
<p>All other settings for this API still apply when inlining a watch. In the
following snippet, while the inline watch defines a <code class="literal">compare</code> condition,
during the execution this condition will be ignored:</p>
<div class="pre_wrapper lang-console">
<pre class="programlisting prettyprint lang-console">POST _watcher/watch/_execute
{
  "ignore_condition" : true,
  "watch" : {
    "trigger" : { "schedule" : { "interval" : "10s" } },
    "input" : {
      "search" : {
        "request" : {
          "indices" : [ "logs" ],
          "body" : {
            "query" : {
              "match" : { "message": "error" }
            }
          }
        }
      }
    },
    "condition" : {
      "compare" : { "ctx.payload.hits.total" : { "gt" : 0 }}
    },
    "actions" : {
      "log_error" : {
        "logging" : {
          "text" : "Found {{ctx.payload.hits.total}} errors in the logs"
        }
      }
    }
  }
}</pre>
</div>
<div class="console_widget" data-snippet="snippets/2179.console"></div>
</div>

</div>
<div class="navfooter">
<span class="prev">
<a href="watcher-api-delete-watch.html">« Delete watch API</a>
</span>
<span class="next">
<a href="watcher-api-get-watch.html">Get watch API »</a>
</span>
</div>
</div>

                  <!-- end body -->
                </div>
                <div class="col-xs-12 col-sm-4 col-md-4" id="right_col">
                  <div id="rtpcontainer" style="display: block;">
                    <div class="mktg-promo">
                      <h3>Most Popular</h3>
                      <ul class="icons">
                        <li class="icon-elasticsearch-white"><a href="https://www.elastic.co/webinars/getting-started-elasticsearch?baymax=default&amp;elektra=docs&amp;storm=top-video">Get Started with Elasticsearch: Video</a></li>
                        <li class="icon-kibana-white"><a href="https://www.elastic.co/webinars/getting-started-kibana?baymax=default&amp;elektra=docs&amp;storm=top-video">Intro to Kibana: Video</a></li>
                        <li class="icon-logstash-white"><a href="https://www.elastic.co/webinars/introduction-elk-stack?baymax=default&amp;elektra=docs&amp;storm=top-video">ELK for Logs &amp; Metrics: Video</a></li>
                      </ul>
                    </div>
                  </div>
                </div>
              </div>
            </div>
          </section>

        </div>


<div id="elastic-footer"></div>
<script src="https://www.elastic.co/elastic-footer.js"></script>
<!-- Footer Section end-->

      </section>
    </div>

<script src="/guide/static/jquery.js"></script>
<script type="text/javascript" src="/guide/static/docs.js"></script>
<script type="text/javascript">
  window.initial_state = {}</script>
  </body>
</html>
